CSV Import

The CSV Import feature is a pivotal tool within our platform, designed to streamline the process of integrating external data into your application. By selecting the "CSV Import" function, you embark on a straightforward journey to populate your entities with data from CSV files, enhancing your application's data richness and functionality.

Entity Selection and File Upload

The journey begins in the left sidebar, where you are required to select the target entity for your data import. This step ensures that the data you import aligns with the structure of the chosen entity, facilitating a smooth integration process.

Upon selecting an entity, the central area presents you with a file selection picker, allowing you to upload a CSV file. It's important to note that the system only accepts files with a ".csv" extension, ensuring compatibility and preventing errors during the import process.

Preview and Settings

Following the file upload, a "preview" section appears next to the file picker in the content area. This preview, displaying up to 5 lines from your CSV file, offers a glimpse into how the imported data will appear within the table structure of your application. It's a crucial step for verifying the data's organization and ensuring it meets your expectations before finalizing the import.

Above the preview, you'll find a settings area where you can customize how the system interprets your CSV file. These settings include:

• Encoding Format
  Choose between UTF-8 or ASCII encoding to match the format of your CSV file, ensuring correct interpretation of the data.
• Header Row Identification
  Allows you to specify if the first row of your CSV file serves as a header, which will not be imported as data but used to identify column names.
• Row Separator Character
  Define the character used to separate rows in your CSV file, such as commas or semicolons. This setting ensures that the preview and subsequent import accurately reflect the structure of your data.

Import Log and Controls

The content area's lower section hosts a log, dynamically updating you with messages about the import process, including success notifications, errors, and warnings. This log also displays the import's progress in percentages and indicates if the import is locked, completed, or requires release.

To manage the import process, the content header above the preview area houses crucial controls. These include:

• Send to Database
  Initiates the import process when no current import is underway.
• Rollback
  Available if an import has either completed or is in progress, allowing you to revert the import actions.
• Resolve
  Appears alongside Rollback, enabling you to address any issues encountered during the import and proceed with finalizing the data integration.

Column Mapping: Bridging Data with Entities

After uploading your CSV file and adjusting settings to suit your data structure, the next critical step involves mapping the CSV columns to the corresponding fields of the selected entity. This process is facilitated by the Column Mapper, located directly below the file upload picker in the content area.

The Column Mapper is your tool for specifying which column from the CSV file corresponds to which field in the entity. This step is vital as it ensures that the imported data aligns correctly with the entity's structure. Notably, the system allows you to map a single CSV column to multiple entity fields if required, providing flexibility in how data is integrated into your application. Before proceeding with the database import, it's mandatory to define these mappings to ensure data integrity and accuracy.

Lock and Claim System: Managing Concurrent Imports

A unique aspect of the CSV Import feature is its lock and claim system, designed to maintain order and prevent conflicts during the import process. In essence, this system ensures that only one import operation can occur at any given time across the entire application instance. When a user initiates an import, the feature is locked, rendering it inaccessible to other users until the operation is either rolled back, resolved, or explicitly released by the initiating user.

This lock mechanism is particularly crucial in scenarios where the importing process is interrupted—such as a browser closure or an unexpected exit from the platform. Upon returning, the user who initiated the import will encounter a warning message prompting them to reclaim the import process. This action can only be performed by the original user or an authorized user, such as an administrator, highlighting the importance of proper access controls and user permissions in managing data imports.

Through these steps, the CSV Import feature empowers you to efficiently populate your entities with external data, enhancing your application's data management capabilities and overall utility.